Update docs for process_turn in the profile docs
#4786
Merged
+16
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oxidase
reviewed
Jan 8, 2018
docs/profiles.md
Outdated
| weight | Read/write | Float | Penalty to be applied for this turn (routing weight) | ||
| duration | Read/write | Float | Penalty to be applied for this turn (duration in deciseconds) | ||
| source_mode | Read/write | Enum | Travel mode before the turn. Defined in `include/extractor/travel_mode.hpp` |
There was a problem hiding this comment.
source_mode and target_mode are Read/write properties but not used after process_turn calls and can be Read-only properties. I guess const qualifiers are missing at
osrm-backend/include/extractor/extraction_turn.hpp
Lines 42 to 44 in 6d801e7
docs/profiles.md
Outdated
| weight | Read/write | Float | Penalty to be applied for this turn (routing weight) | ||
| duration | Read/write | Float | Penalty to be applied for this turn (duration in deciseconds) | ||
| source_mode | Read/write | Enum | Travel mode before the turn. Defined in `include/extractor/travel_mode.hpp` | ||
| target_mode | Read/write | Enum | Travel mode after the turn. Defined in `include/extractor/travel_mode.hpp` |
There was a problem hiding this comment.
is_left_hand_driving | Read | Boolean | Is left-hand traffic? | is missing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Updating incorrect docs to support #4775
The available attributes for the
process_turnfunction accessible in the lua profiles were incorrect.Tasklist
CHANGELOG.md entry (How to write a changelog entry)add regression / cucumber cases (see docs/testing.md)Requirements / Relations
None